How to Migrate Capella Project

When upgrading to a new Capella product, your older models may not be compatible right away with this new version. In order to facilitate this transition, Capella offers a migration feature that allows you to migrate your models.

The migrated projects are not backwards compatible. This means that once they are migrated to the new version, they can not be opened with the previous Capella versions.

A Capella version ensures project migration of model coming from the previous major release versions and if any, from previous patches of the current version. (For instance, Capella 5.1 version will be able to migrate models coming from previous major release version (any 1.4.x) and previous patches of the current version (5.x.y)). If your model is too old, then you will have to install an intermediate Capella release to perform the migration.

We strongly recommend that you baseline your model in a version control system before performing the migration operation. Once this is done please continue with the following migration steps:

1. Migrate any libraries towards wich you model has any dependencies. If your libraries have dependencies towards other libraries then they must be migrated first. You should start your migration process with the library that has no external dependencies, and continue progressively to the top dependency.
2. Migrate your projects.

In order to launch the migration process of a Capella Project you must right click on the project and choose Migration > Migrate Project toward current version. The same steps apply to libraries as well.

The displayed dialog allows you to to make a versioned backup (baseline) of the model before running the migration. These backup files will allow you to recover your model in case of any migration problems, even if the model is not managed in a source control system.

We highly advise you to enable the option “Backup models before the migration”.

Some additional migration commands are available on semantic and diagram files allowing advanced migration processes by triggering a migration on each of these files kind separately. For more details see the Commands & User Profiles (online documentation) section.

Project migration in command line

Please refer to the document at Migration command line (online documentation) for more details about launching project migration in command line. An example of how to migrate projects in batch mode can be found at Migration command line in batch mode (online documentation).